<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpLoadProcedure: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="GimpFileProcedure.html" title="GimpFileProcedure">
<link rel="next" href="GimpThumbnailProcedure.html" title="GimpThumbnailProcedure">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GimpLoadProcedure.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GimpLoadProcedure.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GimpFileProcedure.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GimpThumbnailProcedure.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GimpLoadProcedure"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpLoadProcedure.top_of_page"></a>GimpLoadProcedure</span></h2>
<p>GimpLoadProcedure</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GimpLoadProcedure.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="GimpLoadProcedure.html#GimpRunLoadFunc" title="GimpRunLoadFunc ()">*GimpRunLoadFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="returnvalue">GimpProcedure</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpLoadProcedure.html#gimp-load-procedure-new" title="gimp_load_procedure_new ()">gimp_load_procedure_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GimpLoadProcedure.html#gimp-load-procedure-set-handles-raw" title="gimp_load_procedure_set_handles_raw ()">gimp_load_procedure_set_handles_raw</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpLoadProcedure.html#gimp-load-procedure-get-handles-raw" title="gimp_load_procedure_get_handles_raw ()">gimp_load_procedure_get_handles_raw</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GimpLoadProcedure.html#gimp-load-procedure-set-thumbnail-loader" title="gimp_load_procedure_set_thumbnail_loader ()">gimp_load_procedure_set_thumbnail_loader</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GimpLoadProcedure.html#gimp-load-procedure-get-thumbnail-loader" title="gimp_load_procedure_get_thumbnail_loader ()">gimp_load_procedure_get_thumbnail_loader</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpLoadProcedure.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="GimpProcedure.html" title="GimpProcedure">GimpProcedure</a>
        <span class="lineart">╰──</span> <a class="link" href="GimpFileProcedure.html" title="GimpFileProcedure">GimpFileProcedure</a>
            <span class="lineart">╰──</span> GimpLoadProcedure
</pre>
</div>
<div class="refsect1">
<a name="GimpLoadProcedure.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GimpLoadProcedure.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GimpRunLoadFunc"></a><h3>GimpRunLoadFunc ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="returnvalue">GimpValueArray</span></a> *
<span class="c_punctuation">(</span>*GimpRunLoadFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="type">GimpProcedure</span></a> *procedure</code></em>,
                    <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpRunMode"><span class="type">GimpRunMode</span></a> run_mode</code></em>,
                    <em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
                    <em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="type">GimpValueArray</span></a> *args</code></em>,
                    <em class="parameter"><code><span class="type">gpointer</span> run_data</code></em>);</pre>
<p>The load function is run during the lifetime of the GIMP session,
each time a plug-in load procedure is called.</p>
<div class="refsect3">
<a name="GimpRunLoadFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>procedure</p></td>
<td class="parameter_description"><p>the <a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="type">GimpProcedure</span></a> that runs.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>run_mode</p></td>
<td class="parameter_description"><p>the <a href="../html/libgimpbase3-gimpbaseenums.html#GimpRunMode"><span class="type">GimpRunMode</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>the <span class="type">GFile</span> to load from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>args</p></td>
<td class="parameter_description"><p>the <em class="parameter"><code>procedure</code></em>
's remaining arguments.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>run_data</p></td>
<td class="parameter_description"><p>the run_data given in <a class="link" href="GimpLoadProcedure.html#gimp-load-procedure-new" title="gimp_load_procedure_new ()"><code class="function">gimp_load_procedure_new()</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="GimpRunLoadFunc.returns"></a><h4>Returns</h4>
<p>the <em class="parameter"><code>procedure</code></em>
's return values. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-load-procedure-new"></a><h3>gimp_load_procedure_new ()</h3>
<pre class="programlisting"><a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="returnvalue">GimpProcedure</span></a> *
gimp_load_procedure_new (<em class="parameter"><code><a class="link" href="GimpPlugIn.html" title="GimpPlugIn"><span class="type">GimpPlugIn</span></a> *plug_in</code></em>,
                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                         <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpPDBProcType"><span class="type">GimpPDBProcType</span></a> proc_type</code></em>,
                         <em class="parameter"><code><a class="link" href="GimpLoadProcedure.html#GimpRunLoadFunc" title="GimpRunLoadFunc ()"><span class="type">GimpRunLoadFunc</span></a> run_func</code></em>,
                         <em class="parameter"><code><span class="type">gpointer</span> run_data</code></em>,
                         <em class="parameter"><code><span class="type">GDestroyNotify</span> run_data_destroy</code></em>);</pre>
<p>Creates a new load procedure named <em class="parameter"><code>name</code></em>
 which will call <em class="parameter"><code>run_func</code></em>

when invoked.</p>
<p>See <a class="link" href="GimpProcedure.html#gimp-procedure-new" title="gimp_procedure_new ()"><code class="function">gimp_procedure_new()</code></a> for information about <em class="parameter"><code>proc_type</code></em>
.</p>
<p><a class="link" href="GimpLoadProcedure.html" title="GimpLoadProcedure"><span class="type">GimpLoadProcedure</span></a> is a <a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="type">GimpProcedure</span></a> subclass that makes it easier
to write file load procedures.</p>
<p>It automatically adds the standard</p>
<p>(<a href="../html/libgimpbase3-gimpbaseenums.html#GimpRunMode"><span class="type">GimpRunMode</span></a>, <span class="type">GFile</span>)</p>
<p>arguments and the standard</p>
<p>(<a class="link" href="GimpImage.html" title="gimpimage"><span class="type">GimpImage</span></a>)</p>
<p>return value of a load procedure. It is possible to add additional
arguments.</p>
<p>When invoked via <a class="link" href="GimpProcedure.html#gimp-procedure-run" title="gimp_procedure_run ()"><code class="function">gimp_procedure_run()</code></a>, it unpacks these standard
arguments and calls <em class="parameter"><code>run_func</code></em>
 which is a <a class="link" href="GimpLoadProcedure.html#GimpRunLoadFunc" title="GimpRunLoadFunc ()"><span class="type">GimpRunLoadFunc</span></a>. The
"args" <a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-GimpValueArray.html#GimpValueArray"><span class="type">GimpValueArray</span></a> of <a class="link" href="GimpLoadProcedure.html#GimpRunLoadFunc" title="GimpRunLoadFunc ()"><span class="type">GimpRunLoadFunc</span></a> only contains
additionally added arguments.</p>
<div class="refsect3">
<a name="gimp-load-procedure-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plug_in</p></td>
<td class="parameter_description"><p>a <a class="link" href="GimpPlugIn.html" title="GimpPlugIn"><span class="type">GimpPlugIn</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the new procedure's name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>proc_type</p></td>
<td class="parameter_description"><p>the new procedure's <a href="../html/libgimpbase3-gimpbaseenums.html#GimpPDBProcType"><span class="type">GimpPDBProcType</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>run_func</p></td>
<td class="parameter_description"><p>the run function for the new procedure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>run_data</p></td>
<td class="parameter_description"><p>user data passed to <em class="parameter"><code>run_func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>run_data_destroy</p></td>
<td class="parameter_description"><p>free function for <em class="parameter"><code>run_data</code></em>
, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-load-procedure-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GimpProcedure.html" title="GimpProcedure"><span class="type">GimpProcedure</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-load-procedure-set-handles-raw"></a><h3>gimp_load_procedure_set_handles_raw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_load_procedure_set_handles_raw (<em class="parameter"><code><a class="link" href="GimpLoadProcedure.html" title="GimpLoadProcedure"><span class="type">GimpLoadProcedure</span></a> *procedure</code></em>,
                                     <em class="parameter"><code><span class="type">gboolean</span> handles_raw</code></em>);</pre>
<p>Registers a load loader procedure as capable of handling raw
digital camera loads.</p>
<div class="refsect3">
<a name="gimp-load-procedure-set-handles-raw.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>procedure</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpLoadProcedure.html" title="GimpLoadProcedure"><span class="type">GimpLoadProcedure</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>handles_raw</p></td>
<td class="parameter_description"><p>The procedure's handles raw flag.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-load-procedure-get-handles-raw"></a><h3>gimp_load_procedure_get_handles_raw ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_load_procedure_get_handles_raw (<em class="parameter"><code><a class="link" href="GimpLoadProcedure.html" title="GimpLoadProcedure"><span class="type">GimpLoadProcedure</span></a> *procedure</code></em>);</pre>
<div class="refsect3">
<a name="gimp-load-procedure-get-handles-raw.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>procedure</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpLoadProcedure.html" title="GimpLoadProcedure"><span class="type">GimpLoadProcedure</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-load-procedure-get-handles-raw.returns"></a><h4>Returns</h4>
<p> The procedure's handles raw flag as set with
<a class="link" href="GimpLoadProcedure.html#gimp-load-procedure-set-handles-raw" title="gimp_load_procedure_set_handles_raw ()"><code class="function">gimp_load_procedure_set_handles_raw()</code></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-load-procedure-set-thumbnail-loader"></a><h3>gimp_load_procedure_set_thumbnail_loader ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_load_procedure_set_thumbnail_loader
                               (<em class="parameter"><code><a class="link" href="GimpLoadProcedure.html" title="GimpLoadProcedure"><span class="type">GimpLoadProcedure</span></a> *procedure</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *thumbnail_proc</code></em>);</pre>
<p>Associates a thumbnail loader with a file load procedure.</p>
<p>Some file formats allow for embedded thumbnails, other file formats
contain a scalable image or provide the image data in different
resolutions. A file plug-in for such a format may register a
special procedure that allows GIMP to load a thumbnail preview of
the image. This procedure is then associated with the standard
load procedure using this function.</p>
<div class="refsect3">
<a name="gimp-load-procedure-set-thumbnail-loader.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>procedure</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpLoadProcedure.html" title="GimpLoadProcedure"><span class="type">GimpLoadProcedure</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>thumbnail_proc</p></td>
<td class="parameter_description"><p>The name of the thumbnail load procedure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-load-procedure-get-thumbnail-loader"></a><h3>gimp_load_procedure_get_thumbnail_loader ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_load_procedure_get_thumbnail_loader
                               (<em class="parameter"><code><a class="link" href="GimpLoadProcedure.html" title="GimpLoadProcedure"><span class="type">GimpLoadProcedure</span></a> *procedure</code></em>);</pre>
<div class="refsect3">
<a name="gimp-load-procedure-get-thumbnail-loader.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>procedure</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpLoadProcedure.html" title="GimpLoadProcedure"><span class="type">GimpLoadProcedure</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-load-procedure-get-thumbnail-loader.returns"></a><h4>Returns</h4>
<p> The procedure's thumbnail loader procedure as set with
<a class="link" href="GimpLoadProcedure.html#gimp-load-procedure-set-thumbnail-loader" title="gimp_load_procedure_set_thumbnail_loader ()"><code class="function">gimp_load_procedure_set_thumbnail_loader()</code></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>